home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / ctrevc.z / ctrevc
Encoding:
Text File  |  2002-10-03  |  7.2 KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCTTTTRRRREEEEVVVVCCCC((((3333SSSS))))                                                          CCCCTTTTRRRREEEEVVVVCCCC((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CTREVC - compute some or all of the right and/or left eigenvectors of a
  10.      complex upper triangular matrix T
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CTREVC( SIDE, HOWMNY, SELECT, N, T, LDT, VL, LDVL, VR, LDVR,
  14.                         MM, M, WORK, RWORK, INFO )
  15.  
  16.          CHARACTER      HOWMNY, SIDE
  17.  
  18.          INTEGER        INFO, LDT, LDVL, LDVR, M, MM, N
  19.  
  20.          LOGICAL        SELECT( * )
  21.  
  22.          REAL           RWORK( * )
  23.  
  24.          COMPLEX        T( LDT, * ), VL( LDVL, * ), VR( LDVR, * ), WORK( * )
  25.  
  26. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  27.      These routines are part of the SCSL Scientific Library and can be loaded
  28.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  29.      directs the linker to use the multi-processor version of the library.
  30.  
  31.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  32.      4 bytes (32 bits). Another version of SCSL is available in which integers
  33.      are 8 bytes (64 bits).  This version allows the user access to larger
  34.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  35.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  36.      only one of the two versions; 4-byte integer and 8-byte integer library
  37.      calls cannot be mixed.
  38.  
  39. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  40.      CTREVC computes some or all of the right and/or left eigenvectors of a
  41.      complex upper triangular matrix T. The right eigenvector x and the left
  42.      eigenvector y of T corresponding to an eigenvalue w are defined by:
  43.  
  44.                   T*x = w*x,     y'*T = w*y'
  45.  
  46.      where y' denotes the conjugate transpose of the vector y.
  47.  
  48.      If all eigenvectors are requested, the routine may either return the
  49.      matrices X and/or Y of right or left eigenvectors of T, or the products
  50.      Q*X and/or Q*Y, where Q is an input unitary
  51.      matrix. If T was obtained from the Schur factorization of an original
  52.      matrix A = Q*T*Q', then Q*X and Q*Y are the matrices of right or left
  53.      eigenvectors of A.
  54.  
  55.  
  56. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  57.      SIDE    (input) CHARACTER*1
  58.              = 'R':  compute right eigenvectors only;
  59.              = 'L':  compute left eigenvectors only;
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCTTTTRRRREEEEVVVVCCCC((((3333SSSS))))                                                          CCCCTTTTRRRREEEEVVVVCCCC((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              = 'B':  compute both right and left eigenvectors.
  75.  
  76.      HOWMNY  (input) CHARACTER*1
  77.              = 'A':  compute all right and/or left eigenvectors;
  78.              = 'B':  compute all right and/or left eigenvectors, and
  79.              backtransform them using the input matrices supplied in VR and/or
  80.              VL; = 'S':  compute selected right and/or left eigenvectors,
  81.              specified by the logical array SELECT.
  82.  
  83.      SELECT  (input) LOGICAL array, dimension (N)
  84.              If HOWMNY = 'S', SELECT specifies the eigenvectors to be
  85.              computed.  If HOWMNY = 'A' or 'B', SELECT is not referenced.  To
  86.              select the eigenvector corresponding to the j-th eigenvalue,
  87.              SELECT(j) must be set to .TRUE..
  88.  
  89.      N       (input) INTEGER
  90.              The order of the matrix T. N >= 0.
  91.  
  92.      T       (input/output) COMPLEX array, dimension (LDT,N)
  93.              The upper triangular matrix T.  T is modified, but restored on
  94.              exit.
  95.  
  96.      LDT     (input) INTEGER
  97.              The leading dimension of the array T. LDT >= max(1,N).
  98.  
  99.      VL      (input/output) COMPLEX array, dimension (LDVL,MM)
  100.              On entry, if SIDE = 'L' or 'B' and HOWMNY = 'B', VL must contain
  101.              an N-by-N matrix Q (usually the unitary matrix Q of Schur vectors
  102.              returned by CHSEQR).  On exit, if SIDE = 'L' or 'B', VL contains:
  103.              if HOWMNY = 'A', the matrix Y of left eigenvectors of T; VL is
  104.              lower triangular. The i-th column VL(i) of VL is the eigenvector
  105.              corresponding to T(i,i).  if HOWMNY = 'B', the matrix Q*Y; if
  106.              HOWMNY = 'S', the left eigenvectors of T specified by SELECT,
  107.              stored consecutively in the columns of VL, in the same order as
  108.              their eigenvalues.  If SIDE = 'R', VL is not referenced.
  109.  
  110.      LDVL    (input) INTEGER
  111.              The leading dimension of the array VL.  LDVL >= max(1,N) if SIDE
  112.              = 'L' or 'B'; LDVL >= 1 otherwise.
  113.  
  114.      VR      (input/output) COMPLEX array, dimension (LDVR,MM)
  115.              On entry, if SIDE = 'R' or 'B' and HOWMNY = 'B', VR must contain
  116.              an N-by-N matrix Q (usually the unitary matrix Q of Schur vectors
  117.              returned by CHSEQR).  On exit, if SIDE = 'R' or 'B', VR contains:
  118.              if HOWMNY = 'A', the matrix X of right eigenvectors of T; VR is
  119.              upper triangular. The i-th column VR(i) of VR is the eigenvector
  120.              corresponding to T(i,i).  if HOWMNY = 'B', the matrix Q*X; if
  121.              HOWMNY = 'S', the right eigenvectors of T specified by SELECT,
  122.              stored consecutively in the columns of VR, in the same order as
  123.              their eigenvalues.  If SIDE = 'L', VR is not referenced.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCTTTTRRRREEEEVVVVCCCC((((3333SSSS))))                                                          CCCCTTTTRRRREEEEVVVVCCCC((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      LDVR    (input) INTEGER
  141.              The leading dimension of the array VR.  LDVR >= max(1,N) if SIDE
  142.              = 'R' or 'B'; LDVR >= 1 otherwise.
  143.  
  144.      MM      (input) INTEGER
  145.              The number of columns in the arrays VL and/or VR. MM >= M.
  146.  
  147.      M       (output) INTEGER
  148.              The number of columns in the arrays VL and/or VR actually used to
  149.              store the eigenvectors.  If HOWMNY = 'A' or 'B', M is set to N.
  150.              Each selected eigenvector occupies one column.
  151.  
  152.      WORK    (workspace) COMPLEX array, dimension (2*N)
  153.  
  154.      RWORK   (workspace) REAL array, dimension (N)
  155.  
  156.      INFO    (output) INTEGER
  157.              = 0:  successful exit
  158.              < 0:  if INFO = -i, the i-th argument had an illegal value
  159.  
  160. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  161.      The algorithm used in this program is basically backward (forward)
  162.      substitution, with scaling to make the the code robust against possible
  163.      overflow.
  164.  
  165.      Each eigenvector is normalized so that the element of largest magnitude
  166.      has magnitude 1; here the magnitude of a complex number (x,y) is taken to
  167.      be |x| + |y|.
  168.  
  169.  
  170. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  171.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  172.  
  173.      This man page is available only online.
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.